Skip to content

add an experimental websockets api between client and server #3463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

add an experimental websockets api between client and server #3463

wants to merge 3 commits into from

Conversation

devoncarew
Copy link
Member

  • add an experimental websockets api between client and server
  • listen for it at the /ws endpoint
  • add the ability to call the version command over this channel
  • have a compile-time flag to enable the client using websockets (with the flag disabled for this PR)

Note that the websocket connection is long-lived (we'd need to adjust the backend configuration, but we can set requests timeouts to up to 60m). Before actually enabling this, we'd want to:

  • better understand resource behavior on the backend (we'd need one analysis server and one front-end server instance running per websocket connection)
  • tear down those resources when a websocket connection terminates
  • have the client switch to using a websocket connection for all commands
  • have the client transparently reconnect when a websocket connection terminates
  • understand the new number of continuous server instances required (would we end up using 10x the number of backend instances?)
  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

Note: The Dart team is trialing Gemini Code Assist. Don't take its comments as final Dart team feedback. Use the suggestions if they're helpful; otherwise, wait for a human reviewer.

@devoncarew devoncarew requested a review from johnpryan October 2, 2025 20:26
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 2, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?

This check can be disabled by tagging the PR with skip-breaking-check.

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

This check can be disabled by tagging the PR with skip-changelog-check.

Coverage ✔️
File Coverage

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbol Leaking sources

This check can be disabled by tagging the PR with skip-leaking-check.

License Headers ✔️ 
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/samples/lib/brick_breaker.dart
pkgs/samples/lib/fibonacci.dart
pkgs/samples/lib/hello_world.dart
pkgs/samples/lib/main.dart
pkgs/samples/lib/sunflower.dart

This check can be disabled by tagging the PR with skip-license-check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnpryan johnpryan Awaiting requested review from johnpryan

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@devoncarew